Ask the Experts
POST
GET
DELETE
Form
Request Body | |
grant_type=client_credentials&scope=api
|
Path
URL | |
https://{base-url}/lablink/api/orders/{id}
|
Query String
URL | |
https://{base-url}/lablink/api/orders?state=FINALIZED
|
Request Body
Request Body | |
{
"samples" : 257,
"institute" : "ulm",
"date" : 221101 } |
Boolean
Integer
String
Base64
RFC4648)
200 | ||
---|---|---|
201 | ||
400 | ApiError | |
401 | LoginErrorResponse | |
403 | ApiError | |
404 | ApiError | |
429 | ||
500 |
Authorization: Bearer
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
|
ENTERED | |
---|---|
WAITING_FOR_MATERIAL | |
PROCESSING | |
CONFIRMATORY | |
FINALIZED | |
DELETED |
-
GET /documents
-
GET /documents/{id}
-
GET /examinations
-
GET /locations
-
POST /login
-
POST /orders
-
GET /orders
-
DELETE /orders
-
GET /orders/{id}
-
DELETE /orders/{id}
-
GET /order-states
-
POST /selections
-
DELETE /selections
-
GET /selections/{id}
-
DELETE /selections/{id}
-
GET /selections/{id}/documents
-
GET /selections/{id}/orders
-
GET /selections/{id}/order-states
GET | |
URL | https://{base-url}/lablink/api/documents |
page | query | Integer | 0 | ||
---|---|---|---|---|---|
pageSize | query | Integer | 25 | ||
sort | query | String |
200 | Page<DocumentMetadata> | ||
---|---|---|---|
400 | ApiError |
GET | |
URL | https://{base-url}/lablink/api/documents/{id} |
id | path | String |
---|
200 | Document | ||
---|---|---|---|
400 | ApiError | ||
404 | ApiError |
GET | |
URL | https://{base-url}/lablink/api/examinations |
page | query | Integer | 0 | ||
---|---|---|---|---|---|
pageSize | query | Integer | 25 | ||
sort | query | String | |||
code | query | String | |||
name | query | String | |||
unit | query | String |
200 | Page<Examination> | ||
---|---|---|---|
400 | ApiError |
GET | |
URL | https://{base-url}/lablink/api/locations |
page | query | Integer | 0 | ||
---|---|---|---|---|---|
pageSize | query | Integer | 25 | ||
sort | query | String | |||
name | query | String |
200 | Page<Location> | ||
---|---|---|---|
400 | ApiError |
POST | |
URL | https://{base-url}/lablink/api/login |
username | form | String | |||
---|---|---|---|---|---|
password | form | String | |||
grant_type | form | String | |||
scope | form | String | api |
200 | LoginResponse | ||
---|---|---|---|
400 | LoginErrorResponse |
POST | |
URL | https://{base-url}/lablink/api/orders |
body | body | Order[ ] |
---|
200 | OrderMetadata[ ] | ||
---|---|---|---|
400 | ApiError |
GET | |
URL | https://{base-url}/lablink/api/orders |
page | query | Integer | 0 | ||
---|---|---|---|---|---|
pageSize | query | Integer | 25 | ||
sort | query | String[ ] | createdAt, desc | ||
searchContent | query | String | |||
state | query | String | |||
type | query | String | |||
createdFrom | query | String | |||
createdTo | query | String |
200 | Page<Order> | ||
---|---|---|---|
400 | ApiError |
DELETE | |
URL | https://{base-url}/lablink/api/orders |
body | body | String[ ] |
---|
200 | String[ ] | ||
---|---|---|---|
204 | |||
400 | ApiError |
GET | |
URL | https://{base-url}/lablink/api/orders/{id} |
id | path | String |
---|
200 | Order | ||
---|---|---|---|
400 | ApiError | ||
404 | ApiError |
DELETE | |
URL | https://{base-url}/lablink/api/orders/{id} |
id | path | String |
---|
204 | |||
---|---|---|---|
400 | ApiError | ||
404 | ApiError |
GET | |
URL | https://{base-url}/lablink/api/order-states |
page | query | Integer | 0 | ||
---|---|---|---|---|---|
pageSize | query | Integer | 25 | ||
sort | query | String | |||
searchContent | query | String | |||
state | query | String | |||
type | query | String | |||
createdFrom | query | String | |||
createdTo | query | String |
200 | Page<OrderState> | ||
---|---|---|---|
400 | ApiError | ||
404 | ApiError |
POST | |
URL | https://{base-url}/lablink/api/selections |
body | body | Selection |
---|
201 | SelectionMetadata | Location | |
---|---|---|---|
400 | ApiError |
DELETE | |
URL | https://{base-url}/lablink/api/selections |
body | body | String[ ] |
---|
204 | |||
---|---|---|---|
400 | ApiError | ||
404 | ApiError |
GET | |
URL | https://{base-url}/lablink/api/selections/{id} |
id | path | String |
---|
200 | SelectionMetadata | ||
---|---|---|---|
400 | ApiError | ||
404 | ApiError |
DELETE | |
URL | https://{base-url}/lablink/api/selections/{id} |
id | path | String |
---|
204 | |||
---|---|---|---|
400 | ApiError | ||
404 | ApiError |
GET | |
URL | https://{base-url}/lablink/api/selections/{id}/documents |
id | path | String | |||
---|---|---|---|---|---|
page | query | Integer | 0 | ||
pageSize | query | Integer | 25 | ||
sort | query | String |
200 | Page<Document> | ||
---|---|---|---|
400 | ApiError | ||
404 | ApiError |
GET | |
URL | https://{base-url}/lablink/api/selections/{id}/orders |
id | path | String | |||
---|---|---|---|---|---|
page | query | Integer | 0 | ||
pageSize | query | Integer | 25 | ||
sort | query | String |
200 | Page<Order> | ||
---|---|---|---|
400 | ApiError | ||
404 | ApiError |
GET | |
URL | https://{base-url}/lablink/api/selections/{id}/order-states |
id | path | String | |||
---|---|---|---|---|---|
page | query | Integer | 0 | ||
pageSize | query | Integer | 25 | ||
sort | query | String |
200 | Page<OrderState> | ||
---|---|---|---|
400 | ApiError | ||
404 | ApiError |
- ApiError
- BloodDonor
- Document
- DocumentMetadata
- Error
- Examination
- Link
- Location
- LoginErrorResponse
- LoginResponse
- Order
- OrderExamination
- OrderMetadata
- OrderResult
- OrderState
- Page
- Patient
- Pseudonym
- Selection
- SelectionMetadata
ApiError
type | String | ||
---|---|---|---|
title | String | ||
status | Integer | ||
detail | String | ||
instance | String | ||
errors | Error[ ] |
BloodDonor
donorCode | String | ||
---|---|---|---|
donationCode | String | ||
gender | String | U | |
dateOfBirth | String | 1970-12-31 |
Document
id | String | ||
---|---|---|---|
filename | String |
DocumentMetadata
id | String | ||
---|---|---|---|
filename | String | ||
fileSize | String | ||
fileType | String | pdf, docx, xlsx | |
links | Link |
Error
messageKey | String | ||
---|---|---|---|
messageParams | String[ ] | ||
errors | Error[ ] |
Examination
id | String | ||
---|---|---|---|
code | String | ||
name | String | ||
description | String | ||
unit | String | ||
values | String | "pos", "neg", "nor" |
Link
self | String | https://{base-url}/lablink/api/documents/unique_document_id | |
---|---|---|---|
related | String |
Location
id | String | ||
---|---|---|---|
name | String |
LoginErrorResponse
error | String | invalid_grant | |
---|---|---|---|
error_description | String | Invalid user credentials | |
error_uri | String |
LoginResponse
access_token | String | ||
---|---|---|---|
expires_in | Integer | 300 | |
not-before-policy | Integer | 1662993982 | |
refresh_expires_in | Integer | 1800 | |
refresh_token | String | ||
session_state | String | 7ab2a8b1-8906-4559-b0be-7388e61034fa | |
scope | String | api | |
token_type | String | Bearer |
Order
id | String | ||
---|---|---|---|
locationId | String | ||
reference | String | ||
type | String | ||
bloodDonor | BloodDonor | ||
patient | Patient | ||
pseudonym | Pseudonym | ||
state | String | FINALIZED | |
orderCreationDataTime | String | 2022-04-12T14:10:20.247Z | |
examinations | OrderExamination[ ] |
OrderExamination
id | String | ||
---|---|---|---|
sampleCodes | String[ ] | ||
sampleDate | String | 2000-02-29 | |
sampleTime | String | 13:32:45 | |
results | OrderResult[ ] |
OrderMetadata
id | String | ||
---|---|---|---|
links | Link |
OrderResult
analyteId | String | ||
---|---|---|---|
analyte | String | igg | |
result | String | pos | |
resultType | String | pein | |
unit | String | U/l | |
status | String | FIN | |
resultYieldDateTime | String | 2022-04-12T14:00:00.000Z |
OrderState
id | String | ||
---|---|---|---|
state | String | FINALIZED |
Page
items | Object | ||
---|---|---|---|
page | Integer | T | 1 |
pageSize | Integer | 50 | |
totalCount | Integer | 69 | |
totalPage | Integer | 2 |
Patient
firstName | String | ||
---|---|---|---|
lastName | String | ||
gender | String | U | |
dateOfBirth | String | 1970-12-31 | |
country | String | ||
postCode | String | ||
city | String | ||
address | String | ||
phoneNumberPrimary | String | ||
phoneNumberSecondary | String |
Pseudonym
code | String | T | |
---|---|---|---|
gender | String | U | |
dateOfBirth | String | 1970-12-31 |
Selection
locationId | String | ||
---|---|---|---|
ids | String[ ] | ||
type | String |
SelectionMetadata
id | String | ||
---|---|---|---|
type | String | ||
links | Link |
: 20231010-100
: 20231005-108
: 20230929-108
: 20230823-101
: 20230620-104